home *** CD-ROM | disk | FTP | other *** search
/ Games of Daze / Infomagic - Games of Daze (Summer 1995) (Disc 1 of 2).iso / djgpp / contrib / pdcurs22 / src / portable / getyx.c < prev    next >
Encoding:
C/C++ Source or Header  |  1995-01-26  |  5.5 KB  |  169 lines
  1. /*
  2. ***************************************************************************
  3. * This file comprises part of PDCurses. PDCurses is Public Domain software.
  4. * You may use this code for whatever purposes you desire. This software
  5. * is provided AS IS with NO WARRANTY whatsoever.
  6. * Should this software be used in another application, an acknowledgement
  7. * that PDCurses code is used would be appreciated, but is not mandatory.
  8. *
  9. * Any changes which you make to this software which may improve or enhance
  10. * it, should be forwarded to the current maintainer for the benefit of 
  11. * other users.
  12. *
  13. * The only restriction placed on this code is that no distribution of
  14. * modified PDCurses code be made under the PDCurses name, by anyone
  15. * other than the current maintainer.
  16. * 
  17. * See the file maintain.er for details of the current maintainer.
  18. ***************************************************************************
  19. */
  20. #define    CURSES_LIBRARY    1
  21. #include <curses.h>
  22.  
  23. /* undefine any macros for functions defined in this module */
  24. #undef    getbegy
  25. #undef    getbegx
  26. #undef    getmaxy
  27. #undef    getmaxx
  28. #undef    getpary
  29. #undef    getparx
  30.  
  31. /* undefine any macros for functions called by this module if in debug mode */
  32. #ifdef PDCDEBUG
  33. #endif
  34.  
  35. #ifdef PDCDEBUG
  36. char *rcsid_getyx  = "$Id$";
  37. #endif
  38.  
  39. /*man-start*********************************************************************
  40.  
  41.   Name:                                                         getyx
  42.  
  43.   Synopsis:
  44.       void getyx(WINDOW *win, int y, int x);
  45.       void getparyx(WINDOW *win, int y, int x);
  46.       void getbegyx(WINDOW *win, int y, int x);
  47.       void getmaxyx(WINDOW *win, int y, int x);
  48.  
  49.       int getbegy(WINDOW *win);
  50.       int getbegx(WINDOW *win);
  51.       int getpary(WINDOW *win);
  52.       int getparx(WINDOW *win);
  53.       int getmaxy(WINDOW *win);
  54.       int getmaxx(WINDOW *win);
  55.  
  56.   X/Open Description:
  57.      With the getyx() macro, the cursor position of the window is placed
  58.      in the two integer variables y and x. getbegyx() and getmaxyx()
  59.      return the current beginning coordinates and size of the specified
  60.      window respectively. getparyx() returns the beginning coordinates 
  61.      of the parent's window if the specified window is a sub-window
  62.      otherwise -1 is returned.
  63.  
  64.      These functions are implemented as macros, so their return values
  65.      are undefined. Also as these functions are implemented as macros,
  66.      no '&' is required before the variables y and x.
  67.  
  68.      The functions getbegy(), getbegx(), getmaxy(), getmaxx() ,
  69.      getpary(), and getparx() do return the beginning coordinate or 
  70.      size values, so they can be specified on the right-hand side of 
  71.      an assignment statement. They are, however, implemented as macros.
  72.  
  73.   X/Open Errors:
  74.      No errors are defined for this function.
  75.  
  76.   Portability                             X/Open    BSD    SYS V
  77.                                           Dec '88
  78.       getyx                                 Y        Y       Y
  79.       getparyx                              -        -      4.0
  80.       getbegyx                              -        -      3.0
  81.       getmaxyx                              -        -      3.0
  82.       getbegy                               -        -       -
  83.       getbegx                               -        -       -
  84.       getpary                               -        -       -
  85.       getparx                               -        -       -
  86.       getmaxy                               -        -       -
  87.       getmaxx                               -        -       -
  88.  
  89. **man-end**********************************************************************/
  90.  
  91. /***********************************************************************/
  92. int    getbegy(WINDOW *win)
  93. /***********************************************************************/
  94. {
  95. #ifdef PDCDEBUG
  96.     if (trace_on) PDC_debug("getbegy() - called\n");
  97. #endif
  98.  
  99.     if (win == (WINDOW *)NULL)
  100.         return( ERR );
  101.  
  102.     return(win->_begy);
  103. }
  104. /***********************************************************************/
  105. int    getbegx(WINDOW *win)
  106. /***********************************************************************/
  107. {
  108. #ifdef PDCDEBUG
  109.     if (trace_on) PDC_debug("getbegx() - called\n");
  110. #endif
  111.  
  112.     if (win == (WINDOW *)NULL)
  113.         return( ERR );
  114.  
  115.     return(win->_begx);
  116. }
  117. /***********************************************************************/
  118. int    getpary(WINDOW *win)
  119. /***********************************************************************/
  120. {
  121. #ifdef PDCDEBUG
  122.     if (trace_on) PDC_debug("getpary() - called\n");
  123. #endif
  124.  
  125.     if (win == (WINDOW *)NULL)
  126.         return( ERR );
  127.  
  128.     return(win->_pary);
  129. }
  130. /***********************************************************************/
  131. int    getparx(WINDOW *win)
  132. /***********************************************************************/
  133. {
  134. #ifdef PDCDEBUG
  135.     if (trace_on) PDC_debug("getparx() - called\n");
  136. #endif
  137.  
  138.     if (win == (WINDOW *)NULL)
  139.         return( ERR );
  140.  
  141.     return(win->_parx);
  142. }
  143. /***********************************************************************/
  144. int    getmaxy(WINDOW *win)
  145. /***********************************************************************/
  146. {
  147. #ifdef PDCDEBUG
  148.     if (trace_on) PDC_debug("getmaxy() - called\n");
  149. #endif
  150.  
  151.     if (win == (WINDOW *)NULL)
  152.         return( ERR );
  153.  
  154.     return(win->_maxy);
  155. }
  156. /***********************************************************************/
  157. int    getmaxx(WINDOW *win)
  158. /***********************************************************************/
  159. {
  160. #ifdef PDCDEBUG
  161.     if (trace_on) PDC_debug("getmaxx() - called\n");
  162. #endif
  163.  
  164.     if (win == (WINDOW *)NULL)
  165.         return( ERR );
  166.  
  167.     return(win->_maxx);
  168. }
  169.